home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 41 / Amiga Format CD41 (1999-06)(Future Publishing)(GB)[!][issue 1999-07].iso / -seriously_amiga- / comms / other / s5-trans / s5-trans.shortdoc < prev    next >
Text File  |  1999-04-28  |  12KB  |  277 lines
  1. Quick description and manual for S5-trans.            1999-04-22
  2. Written by Björn Axelsson, gecko@acc.umu.se
  3. ----------------------------------------------------------------
  4. Current version: 0.3
  5. See http://www.acc.umu.se/~gecko/ for latest updates and info!
  6.  
  7. At last - an Amiga <-> Psion S5 file transfer utility, for free!
  8. S5-trans is a package of some basic command-line Psion file handling
  9. utilities. It uses the built-in link and remote file server protocols of
  10. your Psion S5 to give you maximum flexibility and minimum hassle.
  11.  
  12. Disclaimer:
  13. THIS IS EXPERIMENTAL SOFTWARE. USE IT AT YOUR OWN RISK.
  14. It may crash your computer, destroy data and hardware or just be a
  15. pain in the ass.
  16. (Although I find v0.3 very stable, you should be careful when using it)
  17.  
  18. Utilities in the package:
  19.  
  20. s5-get - Transfers files from your S5 to your Amiga
  21. s5-put - Transfers files from your amiga to your S5
  22. s5-dir - Lists the contents of a S5 directory
  23. s5-rename - Renames or moves files and directorys on your S5
  24. s5-delete - Removes files from your S5
  25. s5-mkdir - Creates directorys on your S5
  26. s5-rmdir - Removes directorys on your S5
  27.  
  28. Additional ARexx scripts:
  29. s5-copydir - Backups a complete directory with subdirectories to Amiga
  30.              Written by Neil Bothwick
  31.  
  32. Features:
  33. - Configurable serial device, useful for IO extenders
  34. - No installation needed on the Psion, just make sure your link is up
  35.   and running
  36. - Quick and easy to use
  37. - Very short feature list =)
  38.  
  39. Quick documentation:
  40.  
  41.  Installation:
  42.  1. Copy the "s5-xxx"-files somewhere into your path.
  43.  2. Change (using a text editor, for example "ed") the serial settings
  44.     in the file "s5-trans.config" to something that suites your Amiga.
  45.     A typical setting would be:
  46.       "DEVICE=serial.device BAUD=115200 UNIT=0"
  47.     if you are using the built-in serial port on a fast Amiga.
  48.  3. Copy "s5-trans.config" to env: and envarc: to save the settings
  49.  4. Turn on your S5, and on the System screen press Ctrl-l to bring up
  50.     the remote link settings
  51.  5. Make sure that "Link" is set to "Cable" and that "Baud rate" is the
  52.     same as the on you chose in the "s5-trans.config" file on the Amiga.
  53.  6. Press OK, and you are ready to test the software.
  54.  7. Make sure your cable is connected allright (you will probably need a
  55.     standard 25 to 9 pin adapter at the Amiga end)
  56.  8. "s5-dir c:\" should now give you a listing of the Psion's internal
  57.     RAM-disk's root directory
  58.  9. If you get "Serial timeout" - check cables and serial settings.
  59.  
  60.  Hints:
  61.  - You should always be able to break any transfer with Ctrl-c on the
  62.    Amiga side.
  63.  - The Psion doesn't need to be turned on for theese programs to work.
  64.    It will simply turn itself on automatically as soon as you try to do
  65.    anything.
  66.  - The link will drain batteries from your Psion even when not used, so
  67.    it might be a good idea to turn it off if you are not going to use it
  68.    for a while.
  69.  - On the Psion S5, paths always ends with "\" or ":"
  70.  - If you are getting a lot of CRC errors, try to lower the baud rate
  71.    and make sure no other programs are running in the background.
  72.  
  73.  Settings for all utilities: (In file "env:s5-trans.config")
  74.  
  75.   Option    description                             default value
  76.   ---------------------------------------------------------------
  77.   Device    Serial device to use, e.g.              serial.device
  78.             "serial.device" for the builtin port
  79.   Unit/N    Device unit, e.g. "0" for the builtin   0
  80.             port
  81.   Baud/N    Device speed. Must be same on Psion!    115200
  82.   Quiet/S   Print nothing but error reports         FALSE
  83.             (Overrides Verbose)
  84.   Verbose/S Print more than normally (e.g transfer  FALSE
  85.             rates, etc)
  86.  
  87.  The command line option "Quiet" overrides the Quiet and Verbose settings
  88.  in the config file.
  89.  
  90.  Utilities documentation:
  91.  
  92.   Name       option     description
  93.   -----------------------------------------------
  94.   s5-get     From/A     Psion file to copy
  95.              To         Optional destination file or path on Amiga.
  96.              Quiet/S    Minimises output
  97.  
  98.   Comment:
  99.     If given only a Psion file name it will copy it to the current Amiga
  100.     directory. If given an Amiga path it will copy the file there.
  101.     If a full Amiga path with filename is specified, the file will be
  102.     named as specified.
  103.  
  104.   Name       option     description
  105.   -----------------------------------------------
  106.   s5-put     From/A     Amiga file to copy
  107.              To/A       Destination file or path on Psion
  108.              Quiet/S    Minimises output
  109.  
  110.   Comment:
  111.     If given only a Psion path it will copy the file there. If given a
  112.     complete destination file specifikation, the file will named as
  113.     specified.
  114.  
  115.   Name       option     description
  116.   -----------------------------------------------
  117.   s5-dir     Dir/A      Psion dir to list
  118.              Quiet/S    Minimises output (still prints dir listing though)
  119.  
  120.   Comment:
  121.     Supports basic wildcard pattern ("*" and "?"). E.g. "s5-dir c:\*.txt"
  122.     would list all files in the root dir ending with ".txt".
  123.  
  124.     File flag explanations
  125.      m - modified
  126.      r - read only
  127.      h - hidden
  128.      s - system
  129.      t - temp file
  130.      c - compressed file
  131.  
  132.   Name       option     description
  133.   -----------------------------------------------
  134.   s5-rename  From/A     Old file name including full path.
  135.              To/A       New file name or path
  136.              Quiet/S    Minimises output
  137.  
  138.   Comment:
  139.     Can also be used for moving files between Psion folders.
  140.  
  141.   s5-delete  File/A     Psion file to delete
  142.              Quiet/S    Minimises output
  143.  
  144.   Comment:
  145.     There is currently no way do delete read-only files.
  146.  
  147.   s5-makedir Dir/A      Psion directory to create
  148.              Quiet/S    Minimises output
  149.  
  150.   s5-rmdir   Dir/A      Psion directory to remove
  151.              Quiet/S    Minimises output
  152.  
  153. A cry for help:
  154.   There are some things I would like some help with:
  155.     - ARexx scripts
  156.       If you make some clever scripts like one to copy a whole dir
  157.       structure, or a DirOpus interface - please send them to me, and I
  158.       will distribute them with the next version of s5-trans.
  159.     - Remote printing
  160.       With the PsiWin software it is possible to print via Windows.
  161.       This is done in two parts. First the page(s) to be printed is
  162.       rendered into a special format on the Psion, then they are
  163.       transferred via the Remote Printing Protocol to Windows. Here the
  164.       pages are processed again and sent to the printer.
  165.       I have sucessfully reverse-engineered the printing protocol, but
  166.       have not enough time to start working on the data I get. It seems
  167.       fairly simple with font descriptions, graphics primitives and
  168.       stuff.
  169.       If you think you are brave enough to start working on this I can
  170.       send you a small utility to capture the data and write it to a
  171.       file.
  172.     - Comments
  173.       I want comments on these programs, lots of them!
  174.       This is both to see how big the need is for utilities like this,
  175.       and to see what people out there really wants!
  176.  
  177. FAQ:
  178. Q: How fast is it?
  179. A: The file transfer speed depends on your processor and serial
  180.    hardware. On my 060/50Mhz, standard amiga serial port I get a speed
  181.    around 6.5kb/s, but with an add-on IO board like the IOXtender or
  182.    Whippet you would get higher transfer rates.
  183.  
  184. Q: Why are the executables so large?
  185. A: This software is in a very early development phase, and I decided
  186.    that it was a higher priority to get the software out than to make
  187.    it space-efficient. Later releases will have most code in a shared
  188.    library, making each executable somewhat 20kb smaller.
  189.  
  190. Q: Wouldn't it be great to be able to mount the Psion as a file system
  191.    on the Amiga and browse on it via Workbench?
  192. A: Yes it would. That is one of the main goals with this development
  193.    (see future below)
  194.  
  195. Q: I would like to see feature xxx or have a utility to yyy!
  196. A: Please let me know what you would like to see. I need a lot of user
  197.    feedback to continue this development.
  198.  
  199. History:
  200.   v0.3  - 990422 - Minor bugfix
  201.     * Included Neil Bothwick's S5-copydir script
  202.     * S5-Dir now longer prints a NULL char at the end of every line
  203.  
  204.   v0.2  - 990420 - Second public release
  205.     * Updated and bugfixed this doc (The URL is now correct =)
  206.     * Removed "beta" from the version string (it sounds better without it)
  207.     * Error handling is now done correctly. The utilities exits
  208.       on fatal errors and don't print every CRC error.
  209.     * Unit setting added (I actually forgot it in 0.1)
  210.     * Quiet and Verbose settings added
  211.     * Command line arguments now uses standard AmigaDOS templates
  212.     * Quiet command line option added to all utilities, useful
  213.       in scripts.
  214.     * S5-rename now works correctly with moves
  215.     * s5-get now works correctly if only a path is specified on the
  216.       Amiga side.
  217.     * s5-get doesn't create a file until it has opened the Psion file
  218.     * s5-dir now outputs localised dates (Month names)
  219.     * Fixed an ugly bug in configuration code. It shouldn't have worked
  220.       for me, and it sure didn't work for many others. (Thanks Neil!)
  221.     * Fixed an even uglier bug in the memory handling code that would
  222.       cause gurus every now and then, especially under heavy system
  223.       loads.
  224.     * Fixed harmless enforcer hit related to transfer (CRC) problems.
  225.  
  226.   v0.1b - 990406 - First public version.
  227.  
  228. Future (roadmap, ideas and plans):
  229.  Version 0.4: Fix reported bugs (if any shows up). Rewrite network
  230.               handling code, preparing for 0.5
  231.  Version 0.5: All network handling code moved to an AmigaNCP.library
  232.               clone. Some experimental filehandler supplied as a goodie.
  233.  Version 1.0: Great bugfree coding makes stable and fast applications.
  234.               Complete compability with AmigaNCP.library. Filehandler
  235.               finished.
  236.  Version 2.0: As above, but faster and better. Also includes automatic
  237.               backup, document synchronization and some experimental
  238.               printer server.
  239.  Version 3.0: Symbian has released (yeah, right!) important
  240.               documentation about synchronisation. Now S5-trans also
  241.               converts files to and from Amiga formats as FinalWriter,
  242.               PageStream, TurboCalc, Final Calc etc., synchronises with
  243.               e-mail clients, calendars and everything you need.
  244.  Version 4.0: S5-Trans OS is the most common OS on personal computers.
  245.               BA Design controls the software market, and releases
  246.               everything as Open Source =). Microsoft is history. Life
  247.               is great. Humankind enters a new era of world peace and
  248.               understanding. This will never happen =(.
  249.  
  250. Other future plans:
  251.  - Clean up the documentation.
  252.  - Increase the transfer speed if possible
  253.  - Soon: put serial and link protocol code in a library to reduce
  254.    executable size and connecting time.
  255.  
  256.  - Backup program for storing whole Psion disks and then doing
  257.    incremental backups
  258.  
  259.  - Printing server to make it possible to print via the Amiga (just like
  260.    "Printer via Windows"). I can't do that myself, so if anyone is
  261.    interested in decoding the remote printing data stream (the protocol
  262.    work is already finished), please let me know.
  263.  
  264.  - Going shareware. (Well, I might want some kind of reward if will pe
  265.    putting a lot of my spare time into this project. But don't be afraid
  266.    - it won't be expensive, and the basic file transferring
  267.    functionality will always be free.)
  268.  
  269.  - Mount Amiga disks from the Psion. This was a basic feature on the S3,
  270.    but seems to have been removed from the S5. I've heard some rumors
  271.    (unchecked) that PsiWin 2.2 has this feature, which would mean that
  272.    it adds a new filesystem to the Psion and uses that. If there is
  273.    anyone that has a file ending with .fsy in their c:\System\libs\
  274.    folder, please let me know. (This would actually be easier than doing
  275.    it the other way)
  276.  
  277.